\rcube_imap_search_job

Stackable item to run the search on a specific IMAP folder

Summary

Methods
Properties
Constants
__construct()
run()
get_search_set()
get_result()
$worker
No constants found
search_index()
No protected properties found
N/A
No private methods found
$folder
$search
$charset
$sort_field
$threading
$result
N/A

Properties

$folder

$folder : string

Type

string — IMAP folder to search in

$search

$search : string

Type

string — Search criteria

$charset

$charset : string

Type

string — Search charset

$sort_field

$sort_field : string

Type

string — Header field to sort by

$threading

$threading : bool

Type

bool — True if threaded listing is active

$result

$result : \rcube_result_index|\rcube_result_thread

Type

rcube_result_thread — Search result

Methods

__construct()

__construct(string  $folder, string  $str, string  $charset = null, string  $sort_field = null, bool  $threading = false) : mixed

Class constructor

Parameters

string $folder

IMAP folder to search in

string $str

Search criteria

string $charset

Search charset

string $sort_field

Header field to sort by

bool $threading

True if threaded listing is active

Returns

mixed —

run()

run() : mixed

Executes the IMAP search

Returns

mixed —

get_search_set()

get_search_set() : array

Return the saved search set as a array

Returns

array —

Search set

get_result()

get_result() : \rcube_result_index|\rcube_result_thread

Returns the search result.

Returns

\rcube_result_index|\rcube_result_thread —

Search result

search_index()

search_index() : \rcube_result_index|\rcube_result_thread

Copy of rcube_imap::search_index()

Returns

\rcube_result_index|\rcube_result_thread —

Search result